Swagger是一套方便後端工程師提供API文件給前端的工具,只要在程式語言中寫好API的request和response,這套工具就會自動幫忙把API endpoint呈現出來,這樣有助於方便後端和前端的溝通,後端工程師就不用一直很麻煩的寫文件了。並且現在swagger這個軟體是交由OpenAPI來維護, 現在是Open Source,使用這套軟體就不用額外付費了~
然而在Go這個語言中,swagger有被整合在某些module上面,那這邊我選擇使用的module就是swaggo,這個module可以在code中將想要呈現在swagger上的內容利用註解的方式寫在api上面,這樣要修改該api的request或是response都可以直接在api的function上面修改,相當的方便,後續會有相關的操作。
這邊有一個swaggo github上面提供的Example,可以把swaggo整份clone下來,再選擇該folder進行操作。
今天跑這隻code發現一些小問題,在Mac上面跑的時候會一直出現swagger的css和js檔案抓不到,由於後面的進度還是需要這個軟體,因此今天要先debug。有新的進度會再補上。